Cisco-IOS-XR-ipv4-dhcpd-cfg API API Reference
API generated from Cisco-IOS-XR-ipv4-dhcpd-cfg@2018-10-24.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
IPV4-DHCPD - Update
Update operation of resource: ipv4-dhcpd
ipv4-dhcpdbody object
Request Content-Types: application/json
Request Example
{ "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7" "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": [ null ], DHCP proxy profile
"snoop": [ null ], DHCP Snoop profile
"server": [ null ] DHCP Server profile
}, {
"interface-name": "string", Interface Name "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}, "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100"
},
"allow-client-id-change": [ null ], For BNG session, allow client id change for a\nclient MAC "duplicate-mac": [ null ], Duplicate mac is allowed
"exclude-vlan": [ null ], Exclude vlan
"include-giaddr": [ null ] Include giaddr
}, { "mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF name
}
]
},
"inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7" { { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Create
Create operation of resource: ipv4-dhcpd
ipv4-dhcpdbody object
Request Content-Types: application/json
Request Example
{ "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7" "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": [ null ], DHCP proxy profile
"snoop": [ null ], DHCP Snoop profile
"server": [ null ] DHCP Server profile
}, {
"interface-name": "string", Interface Name "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}, "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100"
},
"allow-client-id-change": [ null ], For BNG session, allow client id change for a\nclient MAC "duplicate-mac": [ null ], Duplicate mac is allowed
"exclude-vlan": [ null ], Exclude vlan
"include-giaddr": [ null ] Include giaddr
}, { "mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF name
}
]
},
"inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7" { { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Delete
Delete operation of resource: ipv4-dhcpd
Successful operation
Internal Error
Response Content-Types: application/json
IPV4-DHCPD - Retrieve
Retrieve operation of resource: ipv4-dhcpd
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"outer-cos": "integer", Configure outer cos values for dhcp packets
range: "0..7" "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": [ null ], DHCP proxy profile
"snoop": [ null ], DHCP Snoop profile
"server": [ null ] DHCP Server profile
}, {
"interface-name": "string", Interface Name "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Profile name and mode "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Set constant integer
Options:
no-format
hex
ascii
extended
"circuit-id": "string", Insert Circuit-id sub-option
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}, "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Number of discovers at which to throttle
range: "0..1000"
default: "100"
},
"allow-client-id-change": [ null ], For BNG session, allow client id change for a\nclient MAC "duplicate-mac": [ null ], Duplicate mac is allowed
"exclude-vlan": [ null ], Exclude vlan
"include-giaddr": [ null ] Include giaddr
}, { "mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF name
}
]
},
"inner-cos": "integer", Configure inner cos values for dhcp packets
range: "0..7" { { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { "mode": "enumeration", Dhcp mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { "mode": "enumeration", Dhcp mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "mode": "enumeration", Dhcp mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "mode": "enumeration", Dhcp mode
Options:
base
relay
snoop
server
proxy
base2
"vrf-profile-name": "string" Profile name
},
"vrf-name": "string" VRF Name
}
]
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of vrf-name
Successful operation
Internal Error
PROFILES - Update
Update operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Create
Create operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Delete
Delete operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Retrieve
Retrieve operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
]
}
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile Name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile Name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile Name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile Name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
},
"profile-name": "string" Profile Name
}
}
MODES - Update
Update operation of resource: modes
modesbody object
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MODES - Create
Create operation of resource: modes
modesbody object
ID of profile-name
Request Content-Types: application/json
Request Example
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MODES - Delete
Delete operation of resource: modes
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
MODES - Retrieve
Retrieve operation of resource: modes
ID of profile-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
}
}
MODE - Update
Update operation of resource: mode
modebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
MODE - Create
Create operation of resource: mode
modebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
MODE - Delete
Delete operation of resource: mode
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MODE - Retrieve
Retrieve operation of resource: mode
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "policy": "enumeration" Specify broadcast flag policy
Options:
replace
drop
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF name {
"gateway-address": "string", Gateway address
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"ip-address": "string" Server's IP address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], Enable Secure Arp "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Specify broadcast flag policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match options
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. { "pattern": "string", Enter hex pattern string
"bit-mask": "string", Enter bit mask pattern string
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Specify match VRF
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"class-name": "string", class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, {
"authenticate": "enumeration", Specify Relay Agent Information Option\nauthenticate
Options:
received
inserted
"option": [ null ], No description
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Enter remote-id value
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] specify requested-ip-address-check disable
}
]
}, "policy": "enumeration", Specify broadcast flag policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
},
"mode": "enumeration", Specify mode
Options:
base
relay
snoop
server
proxy
base2 "enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" Set constant integer
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match options
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}, "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
]
}
SNOOP - Update
Update operation of resource: snoop
snoopbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP - Create
Create operation of resource: snoop
snoopbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP - Delete
Delete operation of resource: snoop
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP - Retrieve
Retrieve operation of resource: snoop
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
},
"trusted": [ null ] Trusted sources
}
}
RELAY-INFORMATION-OPTION - Update
Update operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Create
Create operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Delete
Delete operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Retrieve
Retrieve operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client request "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ] Forward untrusted packets
}
}
REMOTE-ID - Update
Update operation of resource: remote-id
remote-idbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Create
Create operation of resource: remote-id
remote-idbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Delete
Delete operation of resource: remote-id
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Retrieve
Retrieve operation of resource: remote-id
ID of profile-name
ID of mode
Successful operation
Internal Error
BASE - Update
Update operation of resource: base
basebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "enable": [ null ], Enable the DHCP IPv4 Base Profile "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" option all
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE - Create
Create operation of resource: base
basebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "enable": [ null ], Enable the DHCP IPv4 Base Profile "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" option all
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE - Delete
Delete operation of resource: base
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE - Retrieve
Retrieve operation of resource: base
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": [ null ], Enable the DHCP IPv4 Base Profile "profile-name": "string", Profile name
"profile-mode": "integer" none
}, "option": "integer", No description
range: "1..255"
"option-all": "integer" option all
}
}
}, { {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
], {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}, : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}, "profile-name": "string", Profile name
"default-mode": "enumeration" Specify mode
Options:
server
}
}
}
}
DEFAULT-PROFILE - Update
Update operation of resource: default-profile
default-profilebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Create
Create operation of resource: default-profile
default-profilebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Delete
Delete operation of resource: default-profile
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-PROFILE - Retrieve
Retrieve operation of resource: default-profile
ID of profile-name
ID of mode
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
"def-matchoption": "integer" Match option 60
}
]
}
}
}
OPTION-FILTERS - Update
Update operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Create
Create operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Delete
Delete operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Retrieve
Retrieve operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}
}
OPTION-FILTER - Update
Update operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Create
Create operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Delete
Delete operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Retrieve
Retrieve operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "integer", Match option 60
"option-action": "enumeration", Vendor action
Options:
allow
drop
"format": "integer" Set constant integer
}
]
}
DEF-OPTIONS - Update
Update operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Create
Create operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Delete
Delete operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Retrieve
Retrieve operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
DEF-OPTION - Update
Update operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Create
Create operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Delete
Delete operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Retrieve
Retrieve operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
BASE-RELAY-OPT - Update
Update operation of resource: base-relay-opt
base-relay-optbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Create
Create operation of resource: base-relay-opt
base-relay-optbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Delete
Delete operation of resource: base-relay-opt
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-RELAY-OPT - Retrieve
Retrieve operation of resource: base-relay-opt
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : { "authenticate": "integer", Specify Relay Agent Information Option\nauthenticate
"remote-id": "string" Enter remote-id value
}
}
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
BASE-OPTION - Update
Update operation of resource: base-option
base-optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-OPTION - Create
Create operation of resource: base-option
base-optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-OPTION - Delete
Delete operation of resource: base-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-OPTION - Retrieve
Retrieve operation of resource: base-option
ID of profile-name
ID of mode
Successful operation
Internal Error
LIST - Update
Update operation of resource: list
listbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
BASE-MATCH - Update
Update operation of resource: base-match
base-matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-MATCH - Create
Create operation of resource: base-match
base-matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-MATCH - Delete
Delete operation of resource: base-match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BASE-MATCH - Retrieve
Retrieve operation of resource: base-match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}, {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
}
OPTIONS - Update
Update operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Create
Create operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Delete
Delete operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Retrieve
Retrieve operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
}
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Request Content-Types: application/json
Request Example
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Request Content-Types: application/json
Request Example
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"opt60": "integer", none "profile-name": "string", Profile name
"profile-mode": "integer" none
},
"opt60-hex-str": "string", Enter hex pattern string
"format": "integer" Set constant integer
}
]
}
OPTION-PROFILE - Update
Update operation of resource: option-profile
option-profilebody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Create
Create operation of resource: option-profile
option-profilebody object
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Delete
Delete operation of resource: option-profile
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-PROFILE - Retrieve
Retrieve operation of resource: option-profile
ID of profile-name
ID of mode
ID of opt60 opt60-hex-str format
Successful operation
Internal Error
MODE-CLASSES - Update
Update operation of resource: mode-classes
mode-classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MODE-CLASSES - Create
Create operation of resource: mode-classes
mode-classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MODE-CLASSES - Delete
Delete operation of resource: mode-classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MODE-CLASSES - Retrieve
Retrieve operation of resource: mode-classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"class-name": "string", Class name "profile-name": "string", Profile name
"mode": "enumeration" Specify mode
Options:
server
proxy
}
}
]
}
}
MODE-CLASS - Update
Update operation of resource: mode-class
mode-classbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MODE-CLASS - Create
Create operation of resource: mode-class
mode-classbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MODE-CLASS - Delete
Delete operation of resource: mode-class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MODE-CLASS - Retrieve
Retrieve operation of resource: mode-class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
MATCH-DEFAULT - Update
Update operation of resource: match-default
match-defaultbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH-DEFAULT - Create
Create operation of resource: match-default
match-defaultbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH-DEFAULT - Delete
Delete operation of resource: match-default
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH-DEFAULT - Retrieve
Retrieve operation of resource: match-default
ID of profile-name
ID of mode
Successful operation
Internal Error
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of profile-name
ID of mode
Successful operation
Internal Error
SERVER - Update
Update operation of resource: server
serverbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER - Create
Create operation of resource: server
serverbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER - Delete
Delete operation of resource: server
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SERVER - Retrieve
Retrieve operation of resource: server
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
},
"subnet-mask": "string", Configure Subnet Mask
"domain-name": "string", Domain name
"boot-filename": "string", Boot Filename "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
},
"arp-instal-skip-stdalone": [ null ], Skip ARP installation for standalone\nsessions
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"check": [ null ] specify requested-ip-address-check disable
}
],
"server-allow-move": [ null ], Allow dhcp subscriber move "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
},
"secure-arp": [ null ], Enable Secure Arp "authenticate": "integer" Specify Relay Agent Information Option\nauthenticate
}, "dns-server": "string" DNS Server's IP address
},
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class. {
"policy": "enumeration" Specify broadcast flag policy
Options:
ignore
check
unicastalways
}
], "net-bios-name-server": "string" NetBIOSNameServer's IP address
},
"pool": "string", Specify the pool { "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
], "default-router": "string" Router's IP address
}, { {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match options
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
], "force-insert": [ null ] Set constant integer
}
}, "check": [ null ] specify requested-ip-address-check disable
}, { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}, {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}, {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
SERVER-ID-CHECK - Update
Update operation of resource: server-id-check
server-id-checkbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Create
Create operation of resource: server-id-check
server-id-checkbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Delete
Delete operation of resource: server-id-check
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-ID-CHECK - Retrieve
Retrieve operation of resource: server-id-check
ID of profile-name
ID of mode
Successful operation
Internal Error
LEASE-LIMIT - Update
Update operation of resource: lease-limit
lease-limitbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Create
Create operation of resource: lease-limit
lease-limitbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Delete
Delete operation of resource: lease-limit
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-LIMIT - Retrieve
Retrieve operation of resource: lease-limit
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "range": "integer", Value of limit lease count in Decimal
range: "1..240000"
"lease-limit-value": "enumeration" Configure Lease limit value
Options:
per-interface
per-circuit-id
per-remote-id
}
}
REQUESTED-IP-ADDRESS - Update
Update operation of resource: requested-ip-address
requested-ip-addressbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Create
Create operation of resource: requested-ip-address
requested-ip-addressbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Delete
Delete operation of resource: requested-ip-address
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REQUESTED-IP-ADDRESS - Retrieve
Retrieve operation of resource: requested-ip-address
ID of profile-name
ID of mode
Successful operation
Internal Error
AAA-SERVER - Update
Update operation of resource: aaa-server
aaa-serverbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AAA-SERVER - Create
Create operation of resource: aaa-server
aaa-serverbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AAA-SERVER - Delete
Delete operation of resource: aaa-server
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AAA-SERVER - Retrieve
Retrieve operation of resource: aaa-server
ID of profile-name
ID of mode
Successful operation
Internal Error
DHCP-OPTION - Update
Update operation of resource: dhcp-option
dhcp-optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Create
Create operation of resource: dhcp-option
dhcp-optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Delete
Delete operation of resource: dhcp-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-OPTION - Retrieve
Retrieve operation of resource: dhcp-option
ID of profile-name
ID of mode
Successful operation
Internal Error
DEFAULT-ROUTERS - Update
Update operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Create
Create operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Delete
Delete operation of resource: default-routers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Retrieve
Retrieve operation of resource: default-routers
ID of profile-name
ID of mode
Successful operation
Internal Error
NET-BIOS-NAME-SERVERS - Update
Update operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Create
Create operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Delete
Delete operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Retrieve
Retrieve operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match option 60
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match option 60
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match option 60
Options:
circuitid
remoteid
60
77
124
125
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
}
OPTION-DEFAULTS - Update
Update operation of resource: option-defaults
option-defaultsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Create
Create operation of resource: option-defaults
option-defaultsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Delete
Delete operation of resource: option-defaults
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULTS - Retrieve
Retrieve operation of resource: option-defaults
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration" Match option 60
Options:
circuitid
remoteid
60
77
124
125
}
]
}
}
OPTION-DEFAULT - Update
Update operation of resource: option-default
option-defaultbody object
ID of profile-name
ID of mode
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Create
Create operation of resource: option-default
option-defaultbody object
ID of profile-name
ID of mode
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Delete
Delete operation of resource: option-default
ID of profile-name
ID of mode
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-DEFAULT - Retrieve
Retrieve operation of resource: option-default
ID of profile-name
ID of mode
ID of matchoption
Successful operation
Internal Error
OPTIONS - Update
Update operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Create
Create operation of resource: options
optionsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Delete
Delete operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTIONS - Retrieve
Retrieve operation of resource: options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
]
}
}
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Request Content-Types: application/json
Request Example
{ "pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Request Content-Types: application/json
Request Example
{ "pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
"matchoption": "enumeration", Match option 60
Options:
circuitid
remoteid
60
77
124
125
"format": "integer" Set constant integer
}
}
BROADCAST-FLAG - Update
Update operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Create
Create operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Delete
Delete operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Retrieve
Retrieve operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
SESSION - Update
Update operation of resource: session
sessionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
THROTTLE-TYPE - Update
Update operation of resource: throttle-type
throttle-typebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Create
Create operation of resource: throttle-type
throttle-typebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Delete
Delete operation of resource: throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE-TYPE - Retrieve
Retrieve operation of resource: throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
MAC-THROTTLE - Update
Update operation of resource: mac-throttle
mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Create
Create operation of resource: mac-throttle
mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Delete
Delete operation of resource: mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MAC-THROTTLE - Retrieve
Retrieve operation of resource: mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
CLASSES - Update
Update operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Create
Create operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Delete
Delete operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Retrieve
Retrieve operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
]
}
}
CLASS - Update
Update operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "net-bios-name-server": "string" NetBIOSNameServer's IP address
}, {
"l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
], "default-router": "string" Router's IP address
}, { {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
],
"subnet-mask": "string", Configure Subnet Mask
"boot-filename": "string", Boot Filename
"class-name": "string", class name
"domain-name": "string", Domain name
"enable": [ null ], Enable Create or enter server profile\nclass. Deletion of this object also\ncauses deletion of all associated objects\nunder Class.
"next-server": "string", Configure the tftp-server IP to be used\nby the client {
"hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
], "dns-server": "string" DNS Server's IP address
},
"pool": "string", Specify the pool {
"infinite": "string", Set string
"hours": "integer", Hours
range: "0..23"
units: "hour"
"minutes": "integer", Minutes
range: "0..59"
units: "minute"
"days": "integer" Days
range: "0..365"
units: "day"
}
]
}
}
DEFAULT-ROUTERS - Update
Update operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Create
Create operation of resource: default-routers
default-routersbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Delete
Delete operation of resource: default-routers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-ROUTERS - Retrieve
Retrieve operation of resource: default-routers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
NET-BIOS-NAME-SERVERS - Update
Update operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Create
Create operation of resource: net-bios-name-servers
net-bios-name-serversbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Delete
Delete operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NET-BIOS-NAME-SERVERS - Retrieve
Retrieve operation of resource: net-bios-name-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
CLASS-MATCH - Update
Update operation of resource: class-match
class-matchbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ "l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Create
Create operation of resource: class-match
class-matchbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ "l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Delete
Delete operation of resource: class-match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-MATCH - Retrieve
Retrieve operation of resource: class-match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "l2-interface": "string", Specify match l2-interface {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
},
"vrf": "string" Specify match VRF
}
}
CLASS-OPTIONS - Update
Update operation of resource: class-options
class-optionsbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Create
Create operation of resource: class-options
class-optionsbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Delete
Delete operation of resource: class-options
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTIONS - Retrieve
Retrieve operation of resource: class-options
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchoption": "enumeration", Match options
Options:
circuitid
remoteid
60
77
124
125
"bit-mask": "string" Enter bit mask pattern string
}
]
}
}
CLASS-OPTION - Update
Update operation of resource: class-option
class-optionbody object
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Create
Create operation of resource: class-option
class-optionbody object
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Delete
Delete operation of resource: class-option
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Successful operation
Internal Error
Response Content-Types: application/json
CLASS-OPTION - Retrieve
Retrieve operation of resource: class-option
ID of profile-name
ID of mode
ID of class-name
ID of matchoption
Successful operation
Internal Error
LEASE - Update
Update operation of resource: lease
leasebody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Create
Create operation of resource: lease
leasebody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Delete
Delete operation of resource: lease
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Retrieve
Retrieve operation of resource: lease
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
NETBIOS-NODE-TYPE - Update
Update operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Create
Create operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Delete
Delete operation of resource: netbios-node-type
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Retrieve
Retrieve operation of resource: netbios-node-type
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
}
DNS-SERVERS - Update
Update operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Create
Create operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Delete
Delete operation of resource: dns-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Retrieve
Retrieve operation of resource: dns-servers
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
OPTION-CODES - Update
Update operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Create
Create operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Delete
Delete operation of resource: option-codes
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Retrieve
Retrieve operation of resource: option-codes
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
OPTION-CODE - Update
Update operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Create
Create operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Delete
Delete operation of resource: option-code
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Retrieve
Retrieve operation of resource: option-code
ID of profile-name
ID of mode
ID of class-name
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
RELAY - Update
Update operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Create
Create operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Delete
Delete operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Retrieve
Retrieve operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
LEASE - Update
Update operation of resource: lease
leasebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Create
Create operation of resource: lease
leasebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Delete
Delete operation of resource: lease
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE - Retrieve
Retrieve operation of resource: lease
ID of profile-name
ID of mode
Successful operation
Internal Error
NETBIOS-NODE-TYPE - Update
Update operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Create
Create operation of resource: netbios-node-type
netbios-node-typebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Delete
Delete operation of resource: netbios-node-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
NETBIOS-NODE-TYPE - Retrieve
Retrieve operation of resource: netbios-node-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "hybrid-node": "string", Set string
"mixed-node": "string", Set string
"hexadecimal": "string", Hexadecimal number
"broadcast-node": "string", Set string
"peer-to-peer-node": "string" Set string
}
}
DNS-SERVERS - Update
Update operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Create
Create operation of resource: dns-servers
dns-serversbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Delete
Delete operation of resource: dns-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DNS-SERVERS - Retrieve
Retrieve operation of resource: dns-servers
ID of profile-name
ID of mode
Successful operation
Internal Error
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "option-number": "integer", Option number
"option-all": "integer" Set constant integer
}
}
}
}
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
LIST - Update
Update operation of resource: list
listbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
OPTION-CODES - Update
Update operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Create
Create operation of resource: option-codes
option-codesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Delete
Delete operation of resource: option-codes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODES - Retrieve
Retrieve operation of resource: option-codes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
}
OPTION-CODE - Update
Update operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Create
Create operation of resource: option-code
option-codebody object
ID of profile-name
ID of mode
ID of option-code
Request Content-Types: application/json
Request Example
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Delete
Delete operation of resource: option-code
ID of profile-name
ID of mode
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-CODE - Retrieve
Retrieve operation of resource: option-code
ID of profile-name
ID of mode
ID of option-code
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"option-code": "integer", DHCP option code
range: "0..255"
"hex-string": "string", Hexadecimal string
"ascii-string": "string", ASCII string
"ip-address": "string", Server's IP address
"force-insert": "integer" Set constant integer
}
]
}
RELAY - Update
Update operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "enumeration" Relay information option policy
Options:
replace
drop
}, "policy": "enumeration" Relay information option policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check Relay Agent Information Option in\nserver reply
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Create
Create operation of resource: relay
relaybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "policy": "enumeration" Relay information option policy
Options:
replace
drop
}, "policy": "enumeration" Relay information option policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check Relay Agent Information Option in\nserver reply
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Delete
Delete operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY - Retrieve
Retrieve operation of resource: relay
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "policy": "enumeration" Relay information option policy
Options:
replace
drop
}, "policy": "enumeration" Relay information option policy
Options:
ignore
check
unicast-always
}, {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
},
"mac-mismatch-action": "enumeration", Action to take if L2 header source Mac and\ndhcp header mac address don't match
Options:
forward
drop "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check Relay Agent Information Option in\nserver reply
}
}
}
GI-ADDR-POLICY - Update
Update operation of resource: gi-addr-policy
gi-addr-policybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Create
Create operation of resource: gi-addr-policy
gi-addr-policybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Delete
Delete operation of resource: gi-addr-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GI-ADDR-POLICY - Retrieve
Retrieve operation of resource: gi-addr-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vrf-name": "string", VRF Name {
"gateway-address": "string", GatewayAddress
"enable": [ null ], Enable helper - deprecated
"ip-address": "string" IPV4 Address
}
]
}
}
}
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of ip-address
Successful operation
Internal Error
RELAY-INFORMATION-OPTION - Update
Update operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check Relay Agent Information Option in\nserver reply
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Create
Create operation of resource: relay-information-option
relay-information-optionbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check Relay Agent Information Option in\nserver reply
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Delete
Delete operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION-OPTION - Retrieve
Retrieve operation of resource: relay-information-option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "insert": [ null ], Insert Relay Agent Information circuit ID\nand remote ID suboptions in client\nrequests
"subscriber-id": "string", Subscriber ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"remote-id-value": "string" Enter remote-id value
},
"allow-untrusted": [ null ], Forward untrusted packets
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check Relay Agent Information Option in\nserver reply
}
}
REMOTE-ID - Update
Update operation of resource: remote-id
remote-idbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Create
Create operation of resource: remote-id
remote-idbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Delete
Delete operation of resource: remote-id
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE-ID - Retrieve
Retrieve operation of resource: remote-id
ID of profile-name
ID of mode
Successful operation
Internal Error
BROADCAST-POLICY - Update
Update operation of resource: broadcast-policy
broadcast-policybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Create
Create operation of resource: broadcast-policy
broadcast-policybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Delete
Delete operation of resource: broadcast-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-POLICY - Retrieve
Retrieve operation of resource: broadcast-policy
ID of profile-name
ID of mode
Successful operation
Internal Error
PROXY - Update
Update operation of resource: proxy
proxybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Relay information option policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], DHCP IPV4 profile proxy secure-arp enable "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Relay information option policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable the DHCP IPV4 proxy class { "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"option-all": "integer" option all
}
}
}, {
"authenticate": "enumeration", Relay information option authenticate
Options:
received
inserted
"option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Remote ID
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check relay agent information option in\nserver reply
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY - Create
Create operation of resource: proxy
proxybody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Relay information option policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], DHCP IPV4 profile proxy secure-arp enable "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Relay information option policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable the DHCP IPV4 proxy class { "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"option-all": "integer" option all
}
}
}, {
"authenticate": "enumeration", Relay information option authenticate
Options:
received
inserted
"option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Remote ID
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check relay agent information option in\nserver reply
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY - Delete
Delete operation of resource: proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY - Retrieve
Retrieve operation of resource: proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "limit-lease-count": "string", Limit lease count
range: "1..240000"
"limit-type": "enumeration" Lease limit type
Options:
interface
circuit-id
remote-id
circuit-id-remote-id
}, "policy": "enumeration" Relay information option policy
Options:
ignore
check
unicast-always
},
"secure-arp": [ null ], DHCP IPV4 profile proxy secure-arp enable "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}, "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}, "policy": "enumeration" Relay information option policy
Options:
giaddr-policy-keep
}, {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}, "set-server-options": [ null ], Set DHCP server sent options in lease\nproxy generating ACK
"client-lease-time": "integer" Specify client lease proxy time
range: "300..4294967295"
}, {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
},
"delayed-authen-proxy": [ null ], For BNG session, delay the authentication
"enable": [ null ], Enable the DHCP IPV4 proxy class { "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
},
"proxy-allow-move": [ null ], Allow dhcp subscriber move "option": "integer", Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
range: "1..255"
"option-all": "integer" option all
}
}
}, {
"authenticate": "enumeration", Relay information option authenticate
Options:
received
inserted
"option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Remote ID
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check relay agent information option in\nserver reply
}
]
}
}
GIADDR - Update
Update operation of resource: giaddr
giaddrbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GIADDR - Create
Create operation of resource: giaddr
giaddrbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GIADDR - Delete
Delete operation of resource: giaddr
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
GIADDR - Retrieve
Retrieve operation of resource: giaddr
ID of profile-name
ID of mode
Successful operation
Internal Error
CLASSES - Update
Update operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ { "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Create
Create operation of resource: classes
classesbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ { "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Delete
Delete operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
CLASSES - Retrieve
Retrieve operation of resource: classes
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
]
}
}
CLASS - Update
Update operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Create
Create operation of resource: class
classbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Delete
Delete operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
CLASS - Retrieve
Retrieve operation of resource: class
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "pattern": "string", Hex pattern string
"bit-mask": "string", Bit mask pattern
"option-type": "enumeration" Match option
Options:
},
"vrf": "string" Match VRF name
},
"enable": [ null ], Enable the DHCP IPV4 proxy class
"class-name": "string", Class name {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
ID of class-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of profile-name
ID of mode
ID of class-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
}
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
Successful operation
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
ID of profile-name
ID of mode
ID of class-name
ID of vrf-name
ID of server-address
Successful operation
Internal Error
AUTH-USERNAME - Update
Update operation of resource: auth-username
auth-usernamebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Create
Create operation of resource: auth-username
auth-usernamebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Delete
Delete operation of resource: auth-username
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
AUTH-USERNAME - Retrieve
Retrieve operation of resource: auth-username
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "arg1": "enumeration", Username Formatting first argument
Options:
auth-username-mac
auth-username-giaddr
"arg2": "enumeration" Username Formatting second argument
Options:
auth-username-mac
auth-username-giaddr
}
}
RELAY-INFORMATION - Update
Update operation of resource: relay-information
relay-informationbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "authenticate": "enumeration", Relay information option authenticate
Options:
received
inserted
"option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Remote ID
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check relay agent information option in\nserver reply
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Create
Create operation of resource: relay-information
relay-informationbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "authenticate": "enumeration", Relay information option authenticate
Options:
received
inserted
"option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Remote ID
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check relay agent information option in\nserver reply
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Delete
Delete operation of resource: relay-information
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INFORMATION - Retrieve
Retrieve operation of resource: relay-information
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authenticate": "enumeration", Relay information option authenticate
Options:
received
inserted
"option": [ null ], Insert relay rgent information circuit ID\nand remote ID suboptions in client\nrequests
"remote-id-xr": [ null ], Insert Remote-id sub-option
"allow-untrusted": [ null ], Forward untrusted packets
"remote-id-suppress": [ null ], Suppress Remote ID
"vpn-mode": "enumeration", VPN Mode
Options:
rfc
cisco
"remote-id": "string", Remote ID
"circuit-id": [ null ], Insert Circuit-id sub-option
"policy": "enumeration", Relay information option policy
Options:
replace
keep
drop
encapsulate
"vpn": [ null ], Insert VPN options
"check": [ null ] Check relay agent information option in\nserver reply
}
}
DHCP-TO-AAA - Update
Update operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Create
Create operation of resource: dhcp-to-aaa
dhcp-to-aaabody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Delete
Delete operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-TO-AAA - Retrieve
Retrieve operation of resource: dhcp-to-aaa
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "option": "integer", List of options
range: "1..255"
"option-all": "integer" option all
}
}
}
}
OPTION - Update
Update operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Create
Create operation of resource: option
optionbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Delete
Delete operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION - Retrieve
Retrieve operation of resource: option
ID of profile-name
ID of mode
Successful operation
Internal Error
LIST - Update
Update operation of resource: list
listbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Create
Create operation of resource: list
listbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Delete
Delete operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIST - Retrieve
Retrieve operation of resource: list
ID of profile-name
ID of mode
Successful operation
Internal Error
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vrf-name": "string", VRF name {
"server-address": "string", IPv4 address
"gateway-address": "string" Gateway address
}
]
}
}
}
HELPER-ADDRESSES - Update
Update operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Create
Create operation of resource: helper-addresses
helper-addressesbody object
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Delete
Delete operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESSES - Retrieve
Retrieve operation of resource: helper-addresses
ID of profile-name
ID of mode
ID of vrf-name
Successful operation
Internal Error
HELPER-ADDRESS - Update
Update operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Create
Create operation of resource: helper-address
helper-addressbody object
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Delete
Delete operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-ADDRESS - Retrieve
Retrieve operation of resource: helper-address
ID of profile-name
ID of mode
ID of vrf-name
ID of server-address
Successful operation
Internal Error
SESSIONS - Update
Update operation of resource: sessions
sessionsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSIONS - Create
Create operation of resource: sessions
sessionsbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SESSIONS - Delete
Delete operation of resource: sessions
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
SESSIONS - Retrieve
Retrieve operation of resource: sessions
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
}
PROXY-THROTTLE-TYPE - Update
Update operation of resource: proxy-throttle-type
proxy-throttle-typebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Create
Create operation of resource: proxy-throttle-type
proxy-throttle-typebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Delete
Delete operation of resource: proxy-throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-THROTTLE-TYPE - Retrieve
Retrieve operation of resource: proxy-throttle-type
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
}
PROXY-MAC-THROTTLE - Update
Update operation of resource: proxy-mac-throttle
proxy-mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Create
Create operation of resource: proxy-mac-throttle
proxy-mac-throttlebody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Delete
Delete operation of resource: proxy-mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-MAC-THROTTLE - Retrieve
Retrieve operation of resource: proxy-mac-throttle
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-discover": "integer", Number of discovers at which to throttle
range: "1..65535"
"num-block": "integer", Throttle blocking period (in secs)
range: "1..100"
units: "second"
"num-request": "integer" Throttle request period (in secs)
range: "1..100"
units: "second"
}
}
LIMIT-LEASE - Update
Update operation of resource: limit-lease
limit-leasebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Create
Create operation of resource: limit-lease
limit-leasebody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Delete
Delete operation of resource: limit-lease
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LIMIT-LEASE - Retrieve
Retrieve operation of resource: limit-lease
ID of profile-name
ID of mode
Successful operation
Internal Error
LEASE-PROXY - Update
Update operation of resource: lease-proxy
lease-proxybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Create
Create operation of resource: lease-proxy
lease-proxybody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Delete
Delete operation of resource: lease-proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
LEASE-PROXY - Retrieve
Retrieve operation of resource: lease-proxy
ID of profile-name
ID of mode
Successful operation
Internal Error
BROADCAST-FLAG - Update
Update operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Create
Create operation of resource: broadcast-flag
broadcast-flagbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Delete
Delete operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
BROADCAST-FLAG - Retrieve
Retrieve operation of resource: broadcast-flag
ID of profile-name
ID of mode
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"def-matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"def-matchoption": "integer" Match option 60
}
]
}, {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
}
DEF-OPTIONS - Update
Update operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Create
Create operation of resource: def-options
def-optionsbody object
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Delete
Delete operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTIONS - Retrieve
Retrieve operation of resource: def-options
ID of profile-name
ID of mode
Successful operation
Internal Error
DEF-OPTION - Update
Update operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Create
Create operation of resource: def-option
def-optionbody object
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Delete
Delete operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
Response Content-Types: application/json
DEF-OPTION - Retrieve
Retrieve operation of resource: def-option
ID of profile-name
ID of mode
ID of def-matchoption
Successful operation
Internal Error
OPTION-FILTERS - Update
Update operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Create
Create operation of resource: option-filters
option-filtersbody object
ID of profile-name
ID of mode
Request Content-Types: application/json
Request Example
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Delete
Delete operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTERS - Retrieve
Retrieve operation of resource: option-filters
ID of profile-name
ID of mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
]
}
}
OPTION-FILTER - Update
Update operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Create
Create operation of resource: option-filter
option-filterbody object
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Delete
Delete operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
OPTION-FILTER - Retrieve
Retrieve operation of resource: option-filter
ID of profile-name
ID of mode
ID of matchoption pattern format
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "pattern": "string", Enter hex pattern string
"matchaction": "enumeration", Vendor action
Options:
allow
drop
relay
"matchoption": "integer", Match option 60
"format": "integer" Set constant integer
}
}
DATABASE - Update
Update operation of resource: database
databasebody object
Request Content-Types: application/json
Request Example
{ "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": [ null ], Enable DHCP proxy binding database storage to\nfile system
"snoop": [ null ], Enable DHCP snoop binding database storage to\nfile system
"server": [ null ] Enable DHCP server binding database storage to\nfile system
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE - Create
Create operation of resource: database
databasebody object
Request Content-Types: application/json
Request Example
{ "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": [ null ], Enable DHCP proxy binding database storage to\nfile system
"snoop": [ null ], Enable DHCP snoop binding database storage to\nfile system
"server": [ null ] Enable DHCP server binding database storage to\nfile system
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE - Delete
Delete operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE - Retrieve
Retrieve operation of resource: database
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "full-write-interval": "integer", Full file write interval (default 10 minutes)
range: "1..1440"
default: "10"
"incremental-write-interval": "integer", Incremental file write interval (default 1\nminutes)
range: "1..1440"
default: "1"
"proxy": [ null ], Enable DHCP proxy binding database storage to\nfile system
"snoop": [ null ], Enable DHCP snoop binding database storage to\nfile system
"server": [ null ] Enable DHCP server binding database storage to\nfile system
}
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile name
"mode": "enumeration" DHCP mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile name
"mode": "enumeration" DHCP mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile name
"mode": "enumeration" DHCP mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile name
"mode": "enumeration" DHCP mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile name
"mode": "enumeration" DHCP mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string", Interface Name "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}, "profile-name": "string", Profile name
"mode": "enumeration" DHCP mode
Options:
base
relay
snoop
server
proxy
base2
}, "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}, "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
]
}
PROXY-INTERFACE - Update
Update operation of resource: proxy-interface
proxy-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Create
Create operation of resource: proxy-interface
proxy-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Delete
Delete operation of resource: proxy-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PROXY-INTERFACE - Retrieve
Retrieve operation of resource: proxy-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
DHCP-CIRCUIT-ID - Update
Update operation of resource: dhcp-circuit-id
dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Create
Create operation of resource: dhcp-circuit-id
dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Delete
Delete operation of resource: dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
BASE-INTERFACE - Update
Update operation of resource: base-interface
base-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Create
Create operation of resource: base-interface
base-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Delete
Delete operation of resource: base-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BASE-INTERFACE - Retrieve
Retrieve operation of resource: base-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
BASE-DHCP-CIRCUIT-ID - Update
Update operation of resource: base-dhcp-circuit-id
base-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Create
Create operation of resource: base-dhcp-circuit-id
base-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: base-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BASE-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: base-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
RELAY-INTERFACE - Update
Update operation of resource: relay-interface
relay-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Create
Create operation of resource: relay-interface
relay-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Delete
Delete operation of resource: relay-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-INTERFACE - Retrieve
Retrieve operation of resource: relay-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
RELAY-DHCP-CIRCUIT-ID - Update
Update operation of resource: relay-dhcp-circuit-id
relay-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Create
Create operation of resource: relay-dhcp-circuit-id
relay-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: relay-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
RELAY-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: relay-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
STATIC-MODE - Update
Update operation of resource: static-mode
static-modebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-MODE - Create
Create operation of resource: static-mode
static-modebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-MODE - Delete
Delete operation of resource: static-mode
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATIC-MODE - Retrieve
Retrieve operation of resource: static-mode
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
}
STATICS - Update
Update operation of resource: statics
staticsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATICS - Create
Create operation of resource: statics
staticsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
STATICS - Delete
Delete operation of resource: statics
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
STATICS - Retrieve
Retrieve operation of resource: statics
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
}
STATIC - Update
Update operation of resource: static
staticbody object
ID of interface-name
ID of mac-address client-id layer
Successful operation
Internal Error
Response Content-Types: application/json
STATIC - Create
Create operation of resource: static
staticbody object
ID of interface-name
ID of mac-address client-id layer
Successful operation
Internal Error
Response Content-Types: application/json
STATIC - Delete
Delete operation of resource: static
ID of interface-name
ID of mac-address client-id layer
Successful operation
Internal Error
Response Content-Types: application/json
STATIC - Retrieve
Retrieve operation of resource: static
ID of interface-name
ID of mac-address client-id layer
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"client-id": "string", Client Id
range: "0..4294967295"
"layer": "enumeration", DHCP IPV4 Static layer
Options:
layer2
layer3
"static-address": "string", IP address
"mac-address": "string" MACAddress
}
]
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of interface-name
Successful operation
Internal Error
SERVER-INTERFACE - Update
Update operation of resource: server-interface
server-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Create
Create operation of resource: server-interface
server-interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Delete
Delete operation of resource: server-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-INTERFACE - Retrieve
Retrieve operation of resource: server-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "profile": "string", Interface profile name "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
}
SERVER-DHCP-CIRCUIT-ID - Update
Update operation of resource: server-dhcp-circuit-id
server-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Create
Create operation of resource: server-dhcp-circuit-id
server-dhcp-circuit-idbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Delete
Delete operation of resource: server-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SERVER-DHCP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: server-dhcp-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "argument10": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument11": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument12": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument13": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument14": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument15": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument16": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"format": "enumeration", Format String
Options:
no-format
hex
ascii
extended
"circuit-id": "string", DHCP IPv4 circuit ID value
"argument6": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument7": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument4": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument5": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument2": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument3": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument1": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument8": "enumeration", Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
"argument9": "enumeration" Argument
Options:
physical-chassis
physical-slot
physical-sub-slot
physical-port
physical-sub-port
inner-vlan-id
outer-vlan-id
l2-interface
l3-interface
host-name
}
}
SNOOP-INTERFACE - Update
Update operation of resource: snoop-interface
snoop-interfacebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Create
Create operation of resource: snoop-interface
snoop-interfacebody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Delete
Delete operation of resource: snoop-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-INTERFACE - Retrieve
Retrieve operation of resource: snoop-interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "format-type": "integer", Format type, 1. Hex 2. ASCII
range: "1..2"
"circuit-id-value": "string" Enter circuit-id value
}
}
}
SNOOP-CIRCUIT-ID - Update
Update operation of resource: snoop-circuit-id
snoop-circuit-idbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Create
Create operation of resource: snoop-circuit-id
snoop-circuit-idbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Delete
Delete operation of resource: snoop-circuit-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SNOOP-CIRCUIT-ID - Retrieve
Retrieve operation of resource: snoop-circuit-id
ID of interface-name
Successful operation
Internal Error
DUPLICATE-MAC-ALLOWED - Update
Update operation of resource: duplicate-mac-allowed
duplicate-mac-allowedbody object
Successful operation
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Create
Create operation of resource: duplicate-mac-allowed
duplicate-mac-allowedbody object
Successful operation
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Delete
Delete operation of resource: duplicate-mac-allowed
Successful operation
Internal Error
Response Content-Types: application/json
DUPLICATE-MAC-ALLOWED - Retrieve
Retrieve operation of resource: duplicate-mac-allowed
Successful operation
Internal Error
RATE-LIMIT - Update
Update operation of resource: rate-limit
rate-limitbody object
Request Content-Types: application/json
Request Example
{ "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Create
Create operation of resource: rate-limit
rate-limitbody object
Request Content-Types: application/json
Request Example
{ "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Delete
Delete operation of resource: rate-limit
Successful operation
Internal Error
Response Content-Types: application/json
RATE-LIMIT - Retrieve
Retrieve operation of resource: rate-limit
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "num-period": "integer", Rate limiter period in msec (default: 200 msec)
range: "1..1000"
default: "200"
"num-discover": "integer" Max DISCOVER packets per rate-limiter period\n(default 100)
range: "0..1000"
default: "100"
}
}